UpdateAdditionalInfo

This operation transfers additional information uploaded by the certifier from the Online Certificate Registration Service to the council's IT system.

path Parameters
CaseID
required
string

A fully qualified application number or case id

header Parameters
OrganisationID
required
string

Used by the API gateway to route the request to the council's API endpoint

IdempotencyId
required
string

Unique Id for this request. Allows the API to respond in an idempotent way if it has already been called with these parameters and prevents duplicate processing. Typically a UUID such as "63a9ba30-7a4b-4fac-b343-d1f05cf089f1"

Request Body schema: application/json

Information request object

caseStatus
required
string [ 1 .. 100 ] characters

Status of the request for additional information

childCaseID
string

An AI case id for RFI

responseDate
required
string <date> non-empty

Date and time of response

responseDetails
string <= 1500 characters

Additional information description provided by the applicant

Array of objects (DownloadableDocument)
object (UpdatedBy)

Responses

Request samples

Content type
application/json
{
  • "caseStatus": "Complete",
  • "childCaseID": "string",
  • "responseDate": "2019-08-24",
  • "responseDetails": "string",
  • "Documents": [
    ],
  • "updatedBy": {
    }
}